版本：V4.1

通知回調API

賬號監聽通知

接口地址

POST 通知回調地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Account-Id	String	Header	是	賬號ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 update：更新
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
account_id	String	Body	是	賬號ID
account_name	String	Body	否	賬號名稱
first_name	String	Body	否	名
last_name	String	Body	否	姓
email	String	Body	否	郵箱

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Account-Id: ar58fa9ac8b6a2401bba0828fab548850

{
  "notice": "account_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
    "account_name": "good",
    "first_name": "tom",
    "last_name": "fly",
    "email": "demo@akubela.com"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

家庭監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 update：更新 delete：刪除
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
family_name	String	Body	否	家庭名稱
online	Boolean	Body	否	判斷家庭在離線狀態 true：在線 false：離線
installed	Boolean	Body	否	判斷家庭安裝狀態 true：安裝完成 false：未安裝完成
accounts	[]Object<account>	Body	否	賬號信息

account說明

參數名	類型	位置	必填	說明
account_id	String	Body	否	賬號ID
account_name	String	Body	否	賬號名稱
first_name	String	Body	否	名
last_name	String	Body	否	姓
email	String	Body	否	郵箱
auth	String	Body	否	賬號權限 admin：擁有者，最高管理員 user：家庭管理員用戶 guest：家庭普通用戶

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "family_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "family_name": "my home",
    "online": true,
    "installed": true,
    "accounts": [
      {
        "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
        "account_name": "good",
        "first_name": "tom",
        "last_name": "fly",
        "email": "demo@akubela.com",
        "auth": "admin"
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

設備監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 sync：同步
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object	Body	是	通知參數

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "device_listen_notice",
  "action": "sync",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {}
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

空間監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 create：創建 update：更新 delete：刪除
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	[]Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
space_id	String	Body	是	空間ID
space_name	String	Body	否	空間名稱
parent_space_id	String	Body	否	父空間ID

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "space_listen_notice",
  "action": "create",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": [
    {
      "parent_space_id": "f8b5a73f8dd84abaa94dcs248be49b0db",
      "space_id": "r8b5a73f8dd84abaa94dcs248be49b0db",
      "space_name": "my room"
    }
  ]
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

場景監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 sync：同步 perform：執行
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
scene_id	String	Body	否	場景ID

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "scene_listen_notice",
  "action": "perform",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0dv"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

溝通監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 create：創建
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
communicate_id	String	Body	是	溝通ID
timestamp	Integer	Body	是	時間戳
from	String	Body	是	發送方ID 賬號ID：發送方爲用戶設備ID：發送方爲設備
to	String	Body	是	接收方ID 住宅ID：對家庭下的用戶與設備羣發賬號ID：接收方爲用戶
format	String	Body	是	消息格式 text：文本 voice：語音 call_failed：呼叫失敗 lock_call：鎖呼叫 call_cancelled：呼叫取消
call_from	String	Body	否	呼叫方
content	String	Body	否	消息內容 text：文本內容 voice：語音文件名
duration	Integer	Body	否	語音時長，單位：秒
call_id	String	Body	否	呼叫ID

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "communication_listen_notice",
  "action": "create",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "communicate_id": "c6e3861d5d4ca4dcd8e76d84f1ecd49b4",
    "timestamp": 193239428275,
    "from": "a1d54e460365949109ec306dc6e37679b",
    "to": "r42bdd7f6cb5ad478f3471539c2547b4e",
    "format": "text",
    "content": "hello"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

報修監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Project-Id	String	Header	是	項目ID
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 create：創建 update：更新 delete：刪除
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
maintenance_id	String	Body	是	報修ID
state	String	Body	否	狀態 wait for confirmation：待確認 in progress：進行中 completed：已完成
feedback	String	Body	否	反饋

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Project-Id: prn45e846ca23ab42c9ae469d988ae129

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "maintenance_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "maintenance_id": "m8b5a73f8dd84abaa94dcs248be49b0d1",
    "state": "completed"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

預約監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Project-Id	String	Header	是	項目ID
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 create：創建 update：更新 delete：刪除
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
booking_id	String	Body	是	預約ID
state	String	Body	否	狀態 rejected：已拒絕 success：成功
pin_code	String	Body	否	PIN碼
qr_code_url	String	Body	否	二維碼地址

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Project-Id: prn45e846ca23ab42c9ae469d988ae129

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "booking_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "booking_id": "b8b5a73f8dd84abaa94dcs248be49b0d1",
    "state": "success",
    "pin_code": "123456",
    "qr_code_url": "https://test.akubela.com/h.png"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

消息監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Project-Id	String	Header	是	項目ID
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 create：創建
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
message_id	String	Body	是	消息ID
message_title	String	Body	是	消息標題
message_content	String	Body	是	消息內容

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Project-Id: prn45e846ca23ab42c9ae469d988ae129

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "message_listen_notice",
  "action": "create",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "message_id": "mbafa332e258aae1badbb27d31128f446",
    "message_title": "test",
    "message_content": "test"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

告警監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Residence-Id	String	Header	是	住宅ID
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 low_battery：低電量 tampered：防拆
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
device_id	String	Body	是	設備ID

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

Residence-Id: rn45e846ca23ab42c9ae469d988ae32a9

{
  "notice": "alarm_listen_notice",
  "action": "low_battery",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "device_id": "d45e846ca23ab42c9ae469d988ae32a96"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

通用設備監聽通知

接口地址

POST 通知回調地址

見通知服務API 配置通知地址

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
notice	String	Body	是	通知名稱
action	String	Body	是	操作類型 create：創建 update：更新 delete：刪除 trigger：觸發
id	String	Body	是	通知ID
timestamp	Integer	Body	是	通知時間
param	Object<param>	Body	是	通知參數

param說明

參數名	類型	位置	必填	說明
device_id	String	Body	是	設備ID
online	Boolean	Body	否	判斷設備在離線狀態 true：在線 false：離線
data	Object	Body	否	數據

返回參數

無

請求示例

POST 通知回調地址

Content-Type: application/json

Accept: application/json

{
  "notice": "general_device_listen_notice",
  "action": "update",
  "id": "n45e846ca23ab42c9ae469d988ae32a96",
  "timestamp": 1540869200562,
  "param": {
    "device_id": "d8b5a73f8dd84abaa94dcs248be49b0d4",
    "online": true
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

失敗返回示例

無

賬號監聽通知​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

家庭監聽通知​

接口地址​

請求參數​

param說明​

account說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

設備監聽通知​

接口地址​

請求參數​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

空間監聽通知​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

場景監聽通知​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

溝通監聽通知​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

報修監聽通知​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

預約監聽通知​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

消息監聽通知​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

告警監聽通知​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

賬號監聽通知

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

家庭監聽通知

接口地址

請求參數

param說明

account說明

返回參數

請求示例

成功返回示例

失敗返回示例

設備監聽通知

接口地址

請求參數

返回參數

請求示例

成功返回示例

失敗返回示例

空間監聽通知

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

場景監聽通知

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

溝通監聽通知

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

報修監聽通知

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

預約監聽通知

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

消息監聽通知

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

告警監聽通知

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例